home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / nftroff.zip / 9.tr < prev    next >
Text File  |  1991-11-21  |  33KB  |  2,256 lines
  1. .de }n
  2. .bp
  3. .sp .5i
  4. ..
  5. .wh -.8i }n
  6. .sp .5i
  7. .po -.4i
  8. .ll 7.5i
  9. .ps 9
  10. .vs 9
  11. .in 0i
  12. .ta 1.63265i
  13. .sp 2
  14. .ne 20
  15. .ps +3
  16. .vs +3
  17. FT_ALT()    Determine status of the Alt key
  18. .br
  19. .ta
  20. .in 0.08i
  21. .ps -3
  22. .vs -3
  23. .sp 2
  24. \fBFT_ALT()
  25. Determine status of the Alt key
  26. .in 0i
  27. .br
  28. \l'6.24i'
  29. .br
  30. .sp
  31. .in 0.08i
  32. \fBSyntax
  33. .sp
  34. .in 0.4i
  35. \fBFT_ALT() -> lValue
  36. .sp
  37. .in 0.08i
  38. \fBArguments
  39. .sp
  40. .in 0.4i
  41. None
  42. .sp
  43. .in 0.08i
  44. \fBReturns
  45. .sp
  46. .in 0.4i
  47. \.T\. if Alt key is pressed, \.F\. if otherwise\.
  48. .sp
  49. .in 0.08i
  50. \fBDescription
  51. .sp
  52. .in 0.4i
  53. This function is useful for times you need to know whether or not the
  54. Alt key is pressed, such as during a MemoEdit()\.
  55. .sp
  56. .in 0.08i
  57. \fBExamples
  58. .sp
  59. .in 0.4i
  60. IF FT_ALT()
  61. .in 0.64i
  62. @24, 0 say "Alt"
  63. .in 0.4i
  64. ELSE
  65. .in 0.64i
  66. .ta 1.2i
  67. @24, 0 say "    "
  68. .br
  69. .ta
  70. .in 0.4i
  71. ENDIF
  72. .sp
  73. .in 0.08i
  74. \fBSource:\fR ALT\.C
  75. .sp
  76. \fBAuthor:\fR Ted Means
  77. .in 0i
  78. .sp
  79. .in 1.5i
  80. .ti -1.5i
  81. .ta 1.5i
  82. .ft B
  83. See Also:    
  84. .ft R
  85. FT_CAPLOCK()
  86. , FT_CTRL()
  87. , FT_NUMLOCK()
  88. , FT_PRTSCR()
  89. , FT_SHIFT()
  90. .ta 1.63265i
  91. .in 0i
  92. .sp 2
  93. .ne 20
  94. .ps +3
  95. .vs +3
  96. FT_CAPLOCK()    Determine and optionally change the status of CapLock key
  97. .br
  98. .ta
  99. .in 0.08i
  100. .ps -3
  101. .vs -3
  102. .sp 2
  103. \fBFT_CAPLOCK()
  104. Determine and optionally change the status of CapLock key
  105. .in 0i
  106. .br
  107. \l'6.24i'
  108. .br
  109. .sp
  110. .in 0.08i
  111. \fBSyntax
  112. .sp
  113. .in 0.4i
  114. \fBFT_CAPLOCK([ <lNewSetting> ]) -> lCurrentSetting
  115. .sp
  116. .in 0.08i
  117. \fBArguments
  118. .sp
  119. .in 0.4i
  120. \fB<lNewSetting>\fR is optional and if supplied is the new setting
  121. for the CapLock key\.  Specify \.T\. to turn CapLock on, or \.F\. to
  122. turn it off\.
  123. .sp
  124. .in 0.08i
  125. \fBReturns
  126. .sp
  127. .in 0.4i
  128. \.T\. if CapLock is set, \.F\. if it isn\'t set\.  The value returned
  129. .in 0.48i
  130. represents the setting in effect prior to any changes that might
  131. by made by <lNewSetting>\.
  132. .sp
  133. .in 0.08i
  134. \fBDescription
  135. .sp
  136. .in 0.4i
  137. This function is useful if you need to know or set the status of the
  138. CapLock key for some reason\.
  139. .sp
  140. .in 0.08i
  141. \fBExamples
  142. .sp
  143. .in 0.4i
  144. IF FT_CAPLOCK()
  145. .in 0.64i
  146. Qout( "CapLock is active" )
  147. .in 0.4i
  148. ENDIF
  149. .sp
  150. .in 0.08i
  151. \fBSource:\fR CAPLOCK\.C
  152. .sp
  153. \fBAuthor:\fR Ted Means
  154. .in 0i
  155. .sp
  156. .in 1.5i
  157. .ti -1.5i
  158. .ta 1.5i
  159. .ft B
  160. See Also:    
  161. .ft R
  162. FT_ALT()
  163. , FT_CTRL()
  164. , FT_NUMLOCK()
  165. , FT_PRTSCR()
  166. , FT_SHIFT()
  167. .ta 1.63265i
  168. .in 0i
  169. .sp 2
  170. .ne 20
  171. .ps +3
  172. .vs +3
  173. FT_CTRL()    Determine status of the Ctrl key
  174. .br
  175. .ta
  176. .in 0.08i
  177. .ps -3
  178. .vs -3
  179. .sp 2
  180. \fBFT_CTRL()
  181. Determine status of the Ctrl key
  182. .in 0i
  183. .br
  184. \l'6.24i'
  185. .br
  186. .sp
  187. .in 0.08i
  188. \fBSyntax
  189. .sp
  190. .in 0.4i
  191. \fBFT_CTRL() -> lValue
  192. .sp
  193. .in 0.08i
  194. \fBArguments
  195. .sp
  196. .in 0.4i
  197. None
  198. .sp
  199. .in 0.08i
  200. \fBReturns
  201. .sp
  202. .in 0.4i
  203. \.T\. if Ctrl key is pressed, \.F\. if otherwise\.
  204. .sp
  205. .in 0.08i
  206. \fBDescription
  207. .sp
  208. .in 0.4i
  209. This function is useful for times you need to know whether or not
  210. the Ctrl key is pressed, such as during a MemoEdit()\.
  211. .sp
  212. .in 0.08i
  213. \fBExamples
  214. .sp
  215. .in 0.4i
  216. IF FT_CTRL()
  217. .in 0.64i
  218. @24, 0 say "Ctrl"
  219. .in 0.4i
  220. ELSE
  221. .in 0.64i
  222. .ta 1.28i
  223. @24, 0 say "    "
  224. .br
  225. .ta
  226. .in 0.4i
  227. ENDIF
  228. .sp
  229. .in 0.08i
  230. \fBSource:\fR CTRL\.C
  231. .sp
  232. \fBAuthor:\fR Ted Means
  233. .in 0i
  234. .sp
  235. .in 1.5i
  236. .ti -1.5i
  237. .ta 1.5i
  238. .ft B
  239. See Also:    
  240. .ft R
  241. FT_CAPLOCK()
  242. , FT_NUMLOCK()
  243. , FT_PRTSCR()
  244. , FT_SHIFT()
  245. , FT_ALT()
  246. .ta 1.63265i
  247. .in 0i
  248. .sp 2
  249. .ne 20
  250. .ps +3
  251. .vs +3
  252. FT_MBUTPRS()    Retrieve button press status
  253. .br
  254. .ta
  255. .in 0.08i
  256. .ps -3
  257. .vs -3
  258. .sp 2
  259. \fBFT_MBUTPRS()
  260. Retrieve button press status
  261. .in 0i
  262. .br
  263. \l'6.24i'
  264. .br
  265. .sp
  266. .in 0.08i
  267. \fBSyntax
  268. .sp
  269. .in 0.32i
  270. \fBFT_MRESET( <nButton> [, @nButPrs [, @nX [, @nY] ] ] ) -> nButStatus
  271. .sp
  272. .in 0.08i
  273. \fBArguments
  274. .sp
  275. .in 0.32i
  276. \fB<nButton>\fR is the mouse button number:
  277. .sp
  278. .in 1.2i
  279. .ta 0.88i
  280. .br
  281. 0 - Left    Button
  282. .br
  283. .ta
  284. .ta 0.88i
  285. .br
  286. 1 - Right    Button
  287. .br
  288. .ta
  289. .br
  290. 2 - Middle Button [if applicable]
  291. .sp
  292. .in 0.32i
  293. \fB<nButPrs>\fR is the number of times the specified button was pressed
  294. .in 1.12i
  295. since the last call to this routine\. PASSED BY REFERENCE\.
  296. .in 0.32i
  297. \fB<nX>\fR is the X position of the cursor when the last press occurred\. PASSED
  298. .in 1.12i
  299. BY REFERENCE\.
  300. .in 0.32i
  301. \fB<nY>\fR is the Y position of the cursor when the last press occurred\. PASSED
  302. .in 1.12i
  303. BY REFERENCE\.
  304. .sp
  305. .sp
  306. .in 0.08i
  307. \fBReturns
  308. .sp
  309. .in 0.32i
  310. An integer representing the button status:
  311. .sp
  312. .in 1.2i
  313. .br
  314. 0 - no buttons pressed
  315. .br
  316. 1 - left button pressed
  317. .br
  318. 2 - right button pressed
  319. .br
  320. 3 - left and right pressed
  321. .br
  322. 4 - middle pressed
  323. .br
  324. 5 - left and middle pressed
  325. .br
  326. 6 - middle and right buttons pressed
  327. .br
  328. 7 - all 3 buttons pressed
  329. .sp
  330. .in 0.08i
  331. \fBDescription
  332. .sp
  333. .in 0.32i
  334. Retrieves the mouse button status\.
  335. .sp
  336. .in 0.08i
  337. \fBExamples
  338. .sp
  339. .in 0.32i
  340. IF Empty( FT_MBUTPRS(1) )
  341. .in 0.56i
  342. ? "No Item selected"
  343. .in 0.32i
  344. ENDIF
  345. .sp
  346. .in 0.08i
  347. \fBSource:\fR MOUSE1\.PRG
  348. .sp
  349. \fBAuthor:\fR Robert DiFalco and Leo Letendre
  350. .in 0i
  351. .sp
  352. .in 1.5i
  353. .ti -1.5i
  354. .ta 1.5i
  355. .ft B
  356. See Also:    
  357. .ft R
  358. FT_MBUTREL()
  359. , FT_MDBLCLK()
  360. .ta 1.63265i
  361. .in 0i
  362. .sp 2
  363. .ne 20
  364. .ps +3
  365. .vs +3
  366. FT_MBUTREL()    Get mouse button release information
  367. .br
  368. .ta
  369. .in 0.08i
  370. .ps -3
  371. .vs -3
  372. .sp 2
  373. \fBFT_MBUTREL()
  374. Get mouse button release information
  375. .in 0i
  376. .br
  377. \l'6.24i'
  378. .br
  379. .sp
  380. .in 0.08i
  381. \fBSyntax
  382. .sp
  383. .in 0.4i
  384. \fBFT_MBUTREL( nButton [, @nButRel [, @nX [, @nY] ] ]) -> nBStat
  385. .sp
  386. .in 0.08i
  387. \fBArguments
  388. .sp
  389. .in 0.4i
  390. \fB<nButton>\fR is the mouse button number
  391. .in 1.2i
  392. .ta 0.88i
  393. .br
  394. 0 - Left    Button
  395. .br
  396. .ta
  397. .ta 0.88i
  398. .br
  399. 1 - Right    Button
  400. .br
  401. .ta
  402. .br
  403. 2 - Middle Button [if applicable]
  404. .sp
  405. .in 0.32i
  406. \fB<nButRel>\fR is the number of times the specified button was released
  407. .in 1.12i
  408. since the last call to this routine\. PASSED BY REFERENCE\.
  409. .sp
  410. .in 0.32i
  411. \fB<nX>\fR is the X position of the cursor when the last release occurred\.
  412. .in 1.12i
  413. PASSED BY REFERENCE\.
  414. .sp
  415. .in 0.32i
  416. \fB<nY>\fR is the Y position of the cursor when the last release occurred\.
  417. .in 1.12i
  418. PASSED BY REFERENCE\.
  419. .sp
  420. .in 0.08i
  421. \fBReturns
  422. .sp
  423. .in 0.4i
  424. .ta 0.8i
  425. <nBStat>    - an integer representing button release status
  426. .br
  427. .ta
  428. .in 1.36i
  429. .br
  430. 0 - None
  431. .br
  432. 1 - Left
  433. .br
  434. 2 - Right
  435. .br
  436. 3 - Middle
  437. .sp
  438. .in 0.08i
  439. \fBDescription
  440. .sp
  441. .in 0.4i
  442. This function returns the release status of the mouse buttons\.
  443. .sp
  444. .in 0.08i
  445. \fBExamples
  446. .sp
  447. .in 0.4i
  448. IF( FT_MBUTREL( 0 ) == 1 )
  449. .in 0.64i
  450. ? "Left button released"
  451. .in 0.4i
  452. ENDIF
  453. .sp
  454. .in 0.08i
  455. \fBSource:\fR MOUSE1\.PRG
  456. .sp
  457. \fBAuthor:\fR Robert DiFalco and Leo Letendre
  458. .in 0i
  459. .sp
  460. .in 1.5i
  461. .ti -1.5i
  462. .ta 1.5i
  463. .ft B
  464. See Also:    
  465. .ft R
  466. FT_MBUTPRS()
  467. , FT_MDBLCLK()
  468. .ta 1.63265i
  469. .in 0i
  470. .sp 2
  471. .ne 20
  472. .ps +3
  473. .vs +3
  474. FT_MCURSOR()    Set the mouse cursor
  475. .br
  476. .ta
  477. .in 0.08i
  478. .ps -3
  479. .vs -3
  480. .sp 2
  481. \fBFT_MCURSOR()
  482. Set the mouse cursor
  483. .in 0i
  484. .br
  485. \l'6.24i'
  486. .br
  487. .sp
  488. .in 0.08i
  489. \fBSyntax
  490. .sp
  491. .in 0.32i
  492. \fBFT_MCURSOR( [ <lState> ] ) -> lCursorState
  493. .sp
  494. .in 0.08i
  495. \fBArguments
  496. .sp
  497. .in 0.32i
  498. \fB<lState>\fR is a logical indicating whether to set the mouse cursor on\.
  499. .in 1.04i
  500. .br
  501. \.T\. - set mouse cursor on
  502. .br
  503. \.F\. - set mouse cursor off
  504. .br
  505. If omitted, no change is made to cursor state
  506. .sp
  507. .in 0.08i
  508. \fBReturns
  509. .sp
  510. .in 0.32i
  511. A logical indicating the previous mouse cursor state\.
  512. .sp
  513. .in 0.08i
  514. \fBDescription
  515. .sp
  516. .in 0.32i
  517. This function works like most Clipper state functions\.  If no value
  518. is sent to FT_MCURSOR() it will return the state of the mouse cursor\.
  519. .sp
  520. .in 0.08i
  521. \fBExamples
  522. .sp
  523. .in 0.32i
  524. IF !( FT_MCURSOR() )
  525. .in 0.56i
  526. FT_MCURSOR( \.T\. )
  527. .in 0.32i
  528. ENDIF
  529. .sp
  530. .in 0.08i
  531. \fBSource:\fR MOUSE1\.PRG
  532. .sp
  533. \fBAuthor:\fR Robert DiFalco and Leo Letendre
  534. .in 0i
  535. .ta 1.63265i
  536. .sp 2
  537. .ne 20
  538. .ps +3
  539. .vs +3
  540. FT_MDBLCLK()    Return true if a double click was detected
  541. .br
  542. .ta
  543. .in 0.08i
  544. .ps -3
  545. .vs -3
  546. .sp 2
  547. \fBFT_MDBLCLK()
  548. Return true if a double click was detected
  549. .in 0i
  550. .br
  551. \l'6.24i'
  552. .br
  553. .sp
  554. .in 0.08i
  555. \fBSyntax
  556. .sp
  557. .in 0.32i
  558. \fBFT_MDBFCLK( [ <nClick> [, <nButton> [, <nInterval> [, <nRow> [, <nCol>;
  559. .in 1.28i
  560. \fB[, <nTime> ] ] ] ] ] ] ) -> lIsDoubleClk
  561. .sp
  562. .in 0.08i
  563. \fBArguments
  564. .sp
  565. .in 0.32i
  566. \fB<nClick>\fR is a numeric value\.  If it is zero FT_MDBLCLK() will not
  567. .in 1.04i
  568. check for the first press but rather will simply wait the
  569. specified period for a single press\. This is useful if this
  570. routine is called from one which in turn responded to a button
  571. press\. If it is not present or not equal to 0, then FT_MDBLCLK()
  572. will wait for two presses of the specified button\.
  573. .sp
  574. .in 0.32i
  575. \fB<nButton>\fR is the mouse button number
  576. .in 1.2i
  577. .ta 0.88i
  578. .br
  579. 0 - Left    Button
  580. .br
  581. .ta
  582. .ta 0.88i
  583. .br
  584. 1 - Right    Button
  585. .br
  586. .ta
  587. .br
  588. 2 - Middle Button [if applicable]
  589. .sp
  590. .in 0.32i
  591. \fB<nInterval>\fR is the interva